Node / ReticulumProjects / Reticulum_CE.git / files / docs / source / conf.py

Displaying Raw • Download

T8b949e# -- Path setup --------------------------------------------------------------

T8b949e# If extensions (or modules to document with autodoc) are in another directory,

T8b949e# add these directories to sys.path here. If the directory is relative to the

T8b949e# documentation root, use os.path.abspath to make it absolute, like shown here.

T8b949e#

Tff7b72import T7ee787os

Tff7b72import T7ee787sys

Te6edf3sysTff7b72.Td2a8ffpathTff7b72.Td2a8ffinsertTb4b4b4(T79c0ff0Tb4b4b4, Te6edf3osTff7b72.Td2a8ffpathTff7b72.Td2a8ffabspathTb4b4b4(Ta5d6ff'Ta5d6ff../..Ta5d6ff'Tb4b4b4)Tb4b4b4)

T8b949e# -- Project information -----------------------------------------------------

Te6edf3project Tff7b72= Ta5d6ff'Ta5d6ffReticulum Network StackTa5d6ff'

Te6edf3copyright Tff7b72= Ta5d6ff'Ta5d6ff2025, Mark QvistTa5d6ff'

Te6edf3author Tff7b72= Ta5d6ff'Ta5d6ffMark QvistTa5d6ff'

Te6edf3execTb4b4b4(Tffa657openTb4b4b4(Ta5d6ff"Ta5d6ff../../RNS/_version.pyTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffrTa5d6ff"Tb4b4b4)Tff7b72.Td2a8ffreadTb4b4b4(Tb4b4b4)Tb4b4b4)

Te6edf3version Tff7b72= Te6edf3__version__

T8b949e# The full version, including alpha/beta/rc tags

Tff7b72import T7ee787RNS

Te6edf3release Tff7b72= Te6edf3RNSTff7b72.Td2a8ff_versionTff7b72.Td2a8ff__version__

T8b949e# -- General configuration ---------------------------------------------------

Te6edf3extensions Tff7b72= Tb4b4b4[

Ta5d6ff"Ta5d6ffsphinx.ext.autodocTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffsphinx_copybuttonTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffsphinx_markdown_builderTa5d6ff"Tb4b4b4,

Tb4b4b4]

Te6edf3autodoc_member_order Tff7b72= Ta5d6ff"Ta5d6ffbysourceTa5d6ff"

Te6edf3toc_object_entries_show_parents Tff7b72= Ta5d6ff"Ta5d6ffhideTa5d6ff"

Te6edf3autodoc_preserve_defaults Tff7b72= Tff7b72True

T8b949e# add_module_names = False

T8b949e# latex_toplevel_sectioning = 'section'

T8b949e# Add any paths that contain templates here, relative to this directory.

Te6edf3templates_path Tff7b72= Tb4b4b4[Ta5d6ff"Ta5d6ff_templatesTa5d6ff"Tb4b4b4]

T8b949e# List of patterns, relative to source directory, that match files and

T8b949e# directories to ignore when looking for source files.

T8b949e# This pattern also affects html_static_path and html_extra_path.

Te6edf3exclude_patterns Tff7b72= Tb4b4b4[Tb4b4b4]

T8b949e# -- Options for HTML output -------------------------------------------------

Te6edf3html_show_sphinx Tff7b72= Tff7b72True

Te6edf3html_theme Tff7b72= Ta5d6ff"Ta5d6fffuroTa5d6ff"

Te6edf3html_logo Tff7b72= Ta5d6ff"Ta5d6ffgraphics/rns_logo_512.pngTa5d6ff"

Te6edf3html_theme_options Tff7b72= Tb4b4b4{

Ta5d6ff"Ta5d6fftop_of_page_buttonTa5d6ff"Tb4b4b4: Tff7b72NoneTb4b4b4,

T8b949e# "footer_icons": [

T8b949e# {

T8b949e# "name": "GitHub",

T8b949e# "url": "https://github.com/markqvist/reticulum",

T8b949e# "html": """

T8b949e# <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">

T8b949e# <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>

T8b949e# </svg>

T8b949e# """,

T8b949e# "class": "",

T8b949e# },

T8b949e# ],

Ta5d6ff"Ta5d6ffdark_css_variablesTa5d6ff"Tb4b4b4: Tb4b4b4{

Ta5d6ff"Ta5d6ffcolor-background-primaryTa5d6ff"Tb4b4b4: Ta5d6ff"Ta5d6ff#202b38Ta5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffcolor-background-secondaryTa5d6ff"Tb4b4b4: Ta5d6ff"Ta5d6ff#161f27Ta5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffcolor-foreground-primaryTa5d6ff"Tb4b4b4: Ta5d6ff"Ta5d6ff#dbdbdbTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffcolor-foreground-secondaryTa5d6ff"Tb4b4b4: Ta5d6ff"Ta5d6ff#a9b1baTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffcolor-brand-primaryTa5d6ff"Tb4b4b4: Ta5d6ff"Ta5d6ff#41adffTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffcolor-background-hoverTa5d6ff"Tb4b4b4: Ta5d6ff"Ta5d6ff#161f27Ta5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffcolor-api-nameTa5d6ff"Tb4b4b4: Ta5d6ff"Ta5d6ff#ffbe85Ta5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffcolor-api-pre-nameTa5d6ff"Tb4b4b4: Ta5d6ff"Ta5d6ff#efae75Ta5d6ff"Tb4b4b4,

Tb4b4b4}Tb4b4b4,

T8b949e# "announcement": "Announcement content",

Tb4b4b4}

Te6edf3html_static_path Tff7b72= Tb4b4b4[Ta5d6ff"Ta5d6ff_staticTa5d6ff"Tb4b4b4]

Te6edf3html_css_files Tff7b72= Tb4b4b4[

Ta5d6ff'Ta5d6ffcustom.cssTa5d6ff'Tb4b4b4,

Tb4b4b4]

T8b949e# html_theme = "pydata_sphinx_theme"

T8b949e# html_theme_options = {

T8b949e# "navbar_start": ["navbar-logo"],

T8b949e# "navbar_center": ["navbar-nav"],

T8b949e# "navbar_end": ["navbar-icon-links"],

T8b949e# "navbar_align": "left",

T8b949e# "left_sidebar_end": [],

T8b949e# "show_nav_level": 5,

T8b949e# "navigation_depth": 5,

T8b949e# "collapse_navigation": True,

T8b949e# }

T8b949e# html_sidebars = {

T8b949e# "**": ["sidebar-nav-bs"]

T8b949e# }

T8b949e# Add any paths that contain custom static files (such as style sheets) here,

T8b949e# relative to this directory. They are copied after the builtin static files,

T8b949e# so a file named "default.css" will overwrite the builtin "default.css".

T8b949e# def check_skip_member(app, what, name, obj, skip, options):

T8b949e# print(what, " | ", name, " | ", obj, " | ", skip, " | ", options)

T8b949e# return False

T8b949e# def setup(app):

T8b949e# app.connect('autodoc-skip-member', check_skip_member)